+2008-06-20 Johan Dahlin <jdahlin@async.com.br>
+
+ * gtk/gtkaccelgroup.c:
+ * gtk/gtkcolorseldialog.c:
+ * gtk/gtkcontainer.c:
+ * gtk/gtkdialog.c:
+ * gtk/gtkentry.c (gtk_entry_class_init):
+ * gtk/gtkfontsel.c:
+ * gtk/gtkhandlebox.c:
+ * gtk/gtklayout.c:
+ * gtk/gtkmenu.c (gtk_menu_class_init):
+ * gtk/gtkmenuitem.c (gtk_menu_item_class_init):
+ * gtk/gtkplug.c (gtk_plug_class_init):
+ * gtk/gtkselection.c:
+ * gtk/gtksocket.c:
+ * gtk/gtktreeselection.c:
+ * gtk/gtkwidget.c (gtk_widget_class_init):
+ * gtk/gtkwindow.c:
+ Add missing Since: gtk-doc markup for newly added GSEAL API.
+ Change all Since: GSEAL-branch to Since: 2.14.
+
2008-06-20 Michael Natterer <mitch@imendio.com>
* gtk/gtkaccelgroup.[ch]: fix some formatting and whitespace in
*
* Locks are added and removed using gtk_accel_group_lock() and
* gtk_accel_group_unlock().
+ *
+ * Since: 2.14
*/
gboolean
gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group)
*
* @returns: #GdkModifierType representing the mask for this
* @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
+ *
+ * Since: 2.14
*/
GdkModifierType
gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group)
*
* Retrieves the #GtkColorSelection widget embedded in the dialog.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GtkWidget*
gtk_color_selection_dialog_get_color_selection (GtkColorSelectionDialog *colorsel)
* Returns: The child widget which has the focus
* inside @container, or %NULL if none is set.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GtkWidget *
gtk_container_get_focus_child (GtkContainer *container)
*
* Returns: the action area.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GtkWidget *
gtk_dialog_get_action_area (GtkDialog *dialog)
* This function similar to gtk_box_pack_start() packs @widget
* with reference to the start of @dialog.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
void
gtk_dialog_pack_start (GtkDialog *dialog,
* This function similar to gtk_box_pack_end() packs @widget
* with reference to the end of @dialog.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
void
gtk_dialog_pack_end (GtkDialog *dialog,
*
* If text is overwritten when typing in the #GtkEntry.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
g_object_class_install_property (gobject_class,
PROP_OVERWRITE_MODE,
*
* The length of the text in the #GtkEntry.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
g_object_class_install_property (gobject_class,
PROP_TEXT_LENGTH,
*
* Sets whether the text is overwritten when typing in the #GtkEntry.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
void
gtk_entry_set_overwrite_mode (GtkEntry *entry,
*
* Return value: whether the text is overwritten when typing.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
gboolean
gtk_entry_get_overwrite_mode (GtkEntry *entry)
* Return value: the current number of characters
* in #GtkEntry, or 0 if there are none.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
guint16
gtk_entry_get_text_length (GtkEntry *entry)
* This returns the #GtkEntry that allows the user to manually enter
* the font family they want to use.
*
- * Return value: A #GtkWidget.
+ * Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_family_entry (GtkFontSelection *fontsel)
* example, 'Sans', 'Serif', etc.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_family_list (GtkFontSelection *fontsel)
* configuration of the font style.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_face_entry (GtkFontSelection *fontsel)
* the selected font. For example, 'Regular', 'Bold', etc.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_face_list (GtkFontSelection *fontsel)
* number manually instead of selecting it from the list of font sizes.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_size_entry (GtkFontSelection *fontsel)
* This returns the #GtkTreeeView used to list font sizes.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_size_list (GtkFontSelection *fontsel)
* This returns the #GtkEntry used to display the font as a preview.
*
* Return value: A #GtkWidget.
+ *
+ * Since: 2.14
**/
GtkWidget *
gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel)
*
* Return value: A #PangoFontFamily representing the selected font
* family. Font families are a collection of font faces.
+ *
+ * Since: 2.14
**/
PangoFontFamily *
gtk_font_selection_get_family (GtkFontSelection *fontsel)
*
* Return value: A #PangoFontFace representing the selected font group
* details (i.e. family, slant, weight, width, etc).
+ *
+ * Since: 2.14
**/
PangoFontFace *
gtk_font_selection_get_face (GtkFontSelection *fontsel)
*
* Return value: A #gint representing the font size selected, or -1
* if not.
+ *
+ * Since: 2.14
**/
gint
gtk_font_selection_get_size (GtkFontSelection *fontsel)
* @fsd: a #GtkFontSelectionDialog
*
* Return value: the #GtkWidget used in the dialog for the 'OK' button.
+ *
+ * Since: 2.14
*/
GtkWidget *
gtk_font_selection_dialog_get_ok_button (GtkFontSelectionDialog *fsd)
* @fsd: a #GtkFontSelectionDialog
*
* Return value: the #GtkWidget used in the dialog for the 'Apply' button.
+ *
+ * Since: 2.14
*/
GtkWidget *
gtk_font_selection_dialog_get_apply_button (GtkFontSelectionDialog *fsd)
*
* Return value: %TRUE if the child is currently detached, otherwise %FALSE
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
gboolean
gtk_handle_box_get_child_detached (GtkHandleBox *handle_box)
* Retrieve the bin window of the layout used for drawing operations.
*
* Return value: a #GdkWindow
+ *
+ * Since: 2.14
**/
GdkWindow*
-gtk_layout_get_bin_window (GtkLayout *layout)
+gtk_layout_get_bin_window (GtkLayout *layout)
{
g_return_val_if_fail (GTK_IS_LAYOUT (layout), NULL);
*
* The currently selected menu item.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_ACTIVE,
*
* The accel group holding accelerators for the menu.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_ACCEL_GROUP,
*
* An accel path used to conveniently construct accel paths of child items.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_ACCEL_PATH,
*
* The widget the menu is attached to.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_ACCEL_PATH,
*
* The monitor the menu will be popped up on.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_MONITOR,
/**
* gtk_menu_get_accel_path
- * @menu: a valid #GtkMenu
+ * @menu: a valid #GtkMenu
*
* Retrieves the accelerator path set on the menu.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
const gchar*
gtk_menu_get_accel_path (GtkMenu *menu)
*
* Retrieves the number of the monitor on which to show the menu.
*
- * Since: GSEAL-branch
- *
* Returns: the number of the monitor on which the menu should
* be popped up or -1
+ *
+ * Since: 2.14
**/
gint
gtk_menu_get_monitor (GtkMenu *menu)
*
* Sets whether the menu item appears justified at the right side of a menu bar.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_RIGHT_JUSTIFIED,
* changes of the menu item's accelerator caused by the user can be
* identified and saved to persistant storage.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
g_object_class_install_property (gobject_class,
PROP_ACCEL_PATH,
*
* Returns: the accelerator path corresponding to this menu item's
* functionality, or %NULL if not set
+ *
+ * Since: 2.14
*/
G_CONST_RETURN gchar *
gtk_menu_item_get_accel_path (GtkMenuItem *menu_item)
*
* The window of the socket the plug is embedded in.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
g_object_class_install_property (gobject_class,
PROP_SOCKET_WINDOW,
* Determines whether the plug is embedded in a socket.
*
* Return value: %TRUE if the plug is embedded in a socket
+ *
+ * Since: 2.14
**/
gboolean
gtk_plug_get_embedded (GtkPlug *plug)
* Retrieves the socket the plug is embedded in.
*
* Return value: the window of the socket, or %NULL
+ *
+ * Since: 2.14
**/
GdkWindow *
gtk_plug_get_socket_window (GtkPlug *plug)
*
* Retrieves the target of the selection.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GdkAtom
gtk_selection_data_get_target (GtkSelectionData *selection_data)
*
* Retrieves the data type of the selection.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GdkAtom
gtk_selection_data_get_data_type (GtkSelectionData *selection_data)
*
* Retrieves the format of the selection.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
gint
gtk_selection_data_get_format (GtkSelectionData *selection_data)
*
* If @length is not %NULL it is filled with the length of data.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
const guchar*
gtk_selection_data_get_data (GtkSelectionData *selection_data,
*
* Retrieves the display of the selection.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GdkDisplay *
gtk_selection_data_get_display (GtkSelectionData *selection_data)
*
* Return value: the window of the plug if available, or %NULL
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GdkWindow*
gtk_socket_get_plug_window (GtkSocket *socket)
*
* Return value: The function.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GtkTreeSelectionFunc
gtk_tree_selection_get_select_function (GtkTreeSelection *selection)
*
* The widget's window if it is realized, %NULL otherwise.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
g_object_class_install_property (gobject_class,
PROP_WINDOW,
*
* Return value: widget's allocation
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
GtkAllocation
gtk_widget_get_allocation (GtkWidget *widget)
*
* Return value: @widget's window.
*
- * Since: GSEAL-branch
+ * Since: 2.14
*/
GdkWindow*
gtk_widget_get_window (GtkWidget *widget)
*
* Returns: the default widget, or %NULL if there is none.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GtkWidget *
gtk_window_get_default (GtkWindow *window)
*
* Returns: A newly-allocated list of windows inside the group.
*
- * Since: GSEAL-branch
+ * Since: 2.14
**/
GList *
gtk_window_group_list_windows (GtkWindowGroup *window_group)